added docs +doctests to BufRead::consume
#782
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
feefladder
force-pushed
the
consume-docs
branch
from
feefadd to
feefadd
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, documentation for
BufRead::consumelinks to the normal docs that mention there could be a logic error when calling consume, even though this function calls advance internally, which should be safe/no logic error if the user knows the size of the underlying buffer. This pr adds documentation for that.Specifically, the issue I had was that there is no
advance-like function on abuf.reader(), even though I knew the underlying buffer size (and I think more people will know it?)CI: https://github.com/feefladder/bytes/actions/runs/14041549907